Framework API

The Framework Application Programming Interface (API) lets you interact with Ektron CMS. Learn more about the Framework API from the following video:The Ektron Framework API and Microsoft LINQ

CRUD operations

Code snippets demonstrate practical used for performing create, read, update, and delete (CRUD) operations on CMS objects, such as how to create content, retrieve a list of users, and delete folders and so on. You can use the code on your own website and then customize it.

The following sections outline how to use CRUD operations with content, but the methodology is the same for all objects that are exposed by the Framework API.

Retrieve

GetItem

The GetItem() method retrieves and returns a single data object. The following code snippet retrieves the content item with ID 30 in the current language.

NOTE: This code respects the permission settings of the currently logged-in user, so if you lack permission to access the content, the object returned will be empty unless you instansiate the object in ApiAccessMode.Admin.

//Create the Content Object set to observe permissions
Ektron.Cms.Framework.Core.Content.Content ContentAPI
  = new Ektron.Cms.Framework.Core.Content.Content();

//Retrieve the content
Ektron.Cms.ContentData contentData;
contentData = ContentAPI.GetItem(30);

//Output the retrieved item's content
Response.Write(contentData.Html);

GetList

The GetList() method retrieves and returns a list of data objects using criteria objects. Criteria objects accept items from enumeration containing fields against which to search, along with an operator and an operand. Use AddFilter() to add these tuples (a set of objects that belong together).

The following code snippet retrieves the content item with ID 30 in the current language.

//Create the Content Object set to observe permissions
Ektron.Cms.Framework.Core.Content.Content ContentAPI
  = new Ektron.Cms.Framework.Core.Content.Content();

//Create the criteria object
Ektron.Cms.Common.Criteria<Ektron.Cms.Common.ContentProperty> myCriteria
  = new Ektron.Cms.Common.Criteria<Ektron.Cms.Common.ContentProperty>();

//Add a filter to specify the root folder
myCriteria.AddFilter(
  Ektron.Cms.Common.ContentProperty.FolderId,
  Ektron.Cms.Common.CriteriaFilterOperator.EqualTo,
  0);

//Add a filter to retrieve only published items
myCriteria.AddFilter(
  Ektron.Cms.Common.ContentProperty.IsPublished,
  Ektron.Cms.Common.CriteriaFilterOperator.EqualTo,
  true);

//Add a filter to retrieve only items that contain the word "TitleSearch"
//in the title
myCriteria.AddFilter(
  Ektron.Cms.Common.ContentProperty.Title,
  Ektron.Cms.Common.CriteriaFilterOperator.Contains,
  "TitleSearch");

//Create the output object
List<Ektron.Cms.ContentData> resultList;

//Retrieve the results
resultList = ContentAPI.GetList(myCriteria);

Criteria use for GetList methods

This section applies to all GetList methods.

The DataProperty enum works with its criteria class and defines properties that the Manager class uses to filter and sort. Specify zero (0) or more criteria to retrieve the objects you want. The criteria object also lets you set the number of items to return, define paging data, and modify sorting.

Criteria objects

Condition. The Logical operator to apply to the filters. The default value is "AND". The criteria condition controls the operator for the default filter group and the AND-ing\Or-ing the filter groups together.
```
public Ektron.Cms.Common.LogicalOperation Condition { set; get; }
```
FilterGroups. Gets a list of filter groups. Filter groups can be created to do filter grouping (that is, parentheses in the where clause). The groups use the criteria's Condition like other filters, but can use their own condition internally.
```
public System.Collections.Generic.List<CriteriaFilterGroup<ActivityCommentProperty>> FilterGroups { get; }
```
Filters. Lists of filters defined in this criteria object. To add new Filters, you can add them here or use the AddFilter method (recommended).
```
public System.Collections.Generic.List<CriteriaFilter<ActivityCommentProperty>> Filters { get; }
```

GroupByField. The group by field to apply to the results.

public Ektron.Cms.Activity.ActivityCommentProperty GroupByField { set; get; }

OrderByDirection. Sets the order direction (ascending or descending).
```
public EkEnumeration.OrderByDirection OrderByDirection { set; get; }
```

OrderByField . Set the property used to order the results.

public Ektron.Cms.Activity.ActivityCommentProperty OrderByField { set; get; }

PagingInfo. By default, page size is 50 for improved performance. Example paging Info:

PagingInfo pageinfo = new PagingInfo();
pageinfo.CurrentPage=1;
pageinfo.RecordsPerPage = 100;
criteria.PagingInfo = pageinfo;

Constructor(property, orderbyDirection)

Sorts results by a property, in ascending or descending order.

AddFilter(property, operator, value)

Filters results based on conditions defined in this method.

criteria.AddFilter(Property.ObjectType, CriteriaFilterOperator.EqualTo, Objectvalue);

LogicalOperation condition

Filters the array of items based on the logical condition set in the AddFilter properties.

criteria.AddFilter(Property.ObjectType, CriteriaFilterOperator.EqualTo,Objectvalue);

List<CriteriaFilterGroup> FilterGroups

Binds data to a listview or gridview.